docs: Provide CN translation for wokwisimulator.rst and dfu.rst #1355

Shen7436 · 2025-11-21T06:26:32Z

This PR:

Adjusts some format issues and unclear expressions for wokwisimulator.rst and dfu.rst in the docs/en/additionalfeatures folder based on Espressif Style Guide.
Provides CN translation for above two docs.
TODO: Closes DOC-12878 once merged

coderabbitai · 2025-11-21T06:26:40Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch docs/translate_wokwisimulator_and_dfu

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Shen7436 · 2025-11-21T06:30:38Z

docs/en/additionalfeatures/wokwisimulator.rst

+1. Install ``wokwi-server`` as explained in the `wokwi-server installation guide <https://github.com/MabezDev/wokwi-server/>`_.
+2. Go to ``Preferences`` > ``C/C++`` > ``Build`` > ``Environment``. In the Eclipse CDT build environment variables, configure ``WOKWI_SERVER_PATH`` with the path to the ``wokwi-server`` executable.
+3. Create a new ``Run launch configuration`` with the ``Wokwi Simulator``.
+4. Select a project and add the Wokwi project ID. The ID of a Wokwi project can be found in its URL. For example, the project ID of the Wokwi project `ESP32 Rust Blinky <https://wokwi.com/projects/345932416223806035>`_ is ``345932416223806035``.


Hi @alirana01 This link leads to a 404 page. Could you pls help fix?

@Shen7436 the project is probably moved or deleted on wokwi side but this is just to show that how to get the id for the project

Shen7436 · 2025-11-21T06:30:55Z

Hi @April-Yjj @leeebo PTAL, thx!

docs/en/additionalfeatures/dfu.rst

leeebo

@Shen7436 LGTM!

April-Yjj

Hi @Shen7436 Overall LGTM, thanks for translation!

April-Yjj · 2025-11-27T06:59:49Z

docs/zh_CN/additionalfeatures/dfu.rst

+设备固件升级 (Device Firmware Upgrade, DFU) 是一种通过通用串行总线 (Universal Serial Bus, USB) 为设备升级固件的机制。需要满足以下要求：
+
+-  ESP32-S2 和 ESP32-S3 芯片支持 DFU。
+-  需要进行一些电气连接工作，可参考这篇面向 ESP32-S2 开发板的 `指南 <https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1>`__，以及这篇面向 ESP32-S3 开发板的 `指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s2/api-guides/dfu.html>`__。USB 外设所需的连接可参见下表。


Suggested change

- 需要进行一些电气连接工作，可参考这篇面向 ESP32-S2 开发板的 `指南 <https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1>`__，以及这篇面向 ESP32-S3 开发板的 `指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s2/api-guides/dfu.html>`__。USB 外设所需的连接可参见下表。

- 手动进行必要的电气连接。对于 ESP32-S2 开发版，请参考 `ESP32-S2 设备固件升级指南 <https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1>`__；对于 ESP32-S3，参考 `ESP32-S3 设备固件升级指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s2/api-guides/dfu.html>`__。USB 外设所需的连接可参见下表。

April-Yjj · 2025-11-27T06:59:59Z

docs/en/additionalfeatures/dfu.rst

-| +5V  | +5V (red)     |
-+------+---------------+
+-  DFU is supported by ESP32-S2 and ESP32-S3 chips.
+-  You will need to do some electrical connection work. You can follow this `guide <https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1>`__ for the ESP32-S2 board, and this `guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html>`__ for the ESP32-S3 board. The necessary connections for the USB peripheral are shown in the following table.


Suggested change

- You will need to do some electrical connection work. You can follow this `guide <https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1>`__ for the ESP32-S2 board, and this `guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html>`__ for the ESP32-S3 board. The necessary connections for the USB peripheral are shown in the following table.

- Make necessary electrical connections manually. You can follow this `guide <https://blog.espressif.com/dfu-using-the-native-usb-on-esp32-s2-for-flashing-the-firmware-b2c4af3335f1>`__ for the ESP32-S2 board, and this `guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html>`__ for the ESP32-S3 board. The necessary connections for the USB peripheral are shown in the following table.

April-Yjj · 2025-11-27T07:02:07Z

docs/en/additionalfeatures/dfu.rst

+      * - GND
+        - GND (black)
+      * - +5V
+        - +5V (red)


A space between number and unit?

April-Yjj · 2025-11-27T07:05:13Z

docs/en/additionalfeatures/dfu.rst

 After meeting the above requirements:

 1. The chip needs to be in bootloader mode for detection as a DFU device and flashing. This can be achieved by pulling GPIO0 down (e.g., pressing the BOOT button), pulsing RESET down for a moment, and releasing GPIO0.
 2. Install USB drivers (Windows only). The drivers can be installed by the `Zadig tool <https://zadig.akeo.ie/>`_.


Suggested change

2. Install USB drivers (Windows only). The drivers can be installed by the `Zadig tool <https://zadig.akeo.ie/>`_.

2. Install USB drivers (Windows only). The drivers can be installed by `Zadig tool <https://zadig.akeo.ie/>`_.

April-Yjj · 2025-11-27T07:06:11Z

docs/en/additionalfeatures/dfu.rst

 1. The chip needs to be in bootloader mode for detection as a DFU device and flashing. This can be achieved by pulling GPIO0 down (e.g., pressing the BOOT button), pulsing RESET down for a moment, and releasing GPIO0.
 2. Install USB drivers (Windows only). The drivers can be installed by the `Zadig tool <https://zadig.akeo.ie/>`_.
+
   - Ensure that the device is in download mode before running the tool and that it detects the device before installing the drivers.


Suggested change

- Ensure that the device is in download mode before running the tool and that it detects the device before installing the drivers.

- Ensure that the device is in download mode before running the tool, and that the tool detects the device before installing the drivers.

April-Yjj · 2025-11-27T07:07:54Z

docs/en/additionalfeatures/dfu.rst

 2. Install USB drivers (Windows only). The drivers can be installed by the `Zadig tool <https://zadig.akeo.ie/>`_.
+
   - Ensure that the device is in download mode before running the tool and that it detects the device before installing the drivers.
   - The Zadig tool might detect several USB interfaces of the target. Install the WinUSB driver only for the interface without a driver installed (likely Interface 2), and avoid re-installing drivers for other interfaces.


Suggested change

- The Zadig tool might detect several USB interfaces of the target. Install the WinUSB driver only for the interface without a driver installed (likely Interface 2), and avoid re-installing drivers for other interfaces.

- Zadig tool might detect several USB interfaces of the target. Install the WinUSB driver only for the interface without a driver installed (likely Interface 2), and avoid re-installing drivers for other interfaces.

April-Yjj · 2025-11-27T07:12:15Z

docs/en/additionalfeatures/dfu.rst


-Additional information, including common errors and known issues, is available in `this <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#usb-drivers-windows-only>`_.
-
+Additional information, including common errors and known issues, is available `here <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#usb-drivers-windows-only>`_.


The link can be more specific? Similarly for Chinese.

Suggested change

Additional information, including common errors and known issues, is available `here <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#usb-drivers-windows-only>`_.

Additional information, including common errors and known issues, is available `here <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#common-errors-and-known-issues>`_.

April-Yjj · 2025-11-27T07:12:34Z

docs/zh_CN/additionalfeatures/dfu.rst

+.. image:: https://user-images.githubusercontent.com/24419842/226182180-286099d3-9c1c-4394-abb0-212d43054529.png
+   :alt: DFU 操作
+
+包括常见错误和已知问题在内的更多信息，可参阅 `此处 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s3/api-guides/dfu.html#usb-windows>`_。


Suggested change

包括常见错误和已知问题在内的更多信息，可参阅 `此处 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s3/api-guides/dfu.html#usb-windows>`_。

包括常见错误和已知问题在内的更多信息，可参阅 `此处 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s3/api-guides/dfu.html#api-guide-dfu-flash-errors>`_。

Shen7436 self-assigned this Nov 21, 2025

Shen7436 added documentation Improvements or additions to documentation documentation 📝 Solely about the documentation of the project. labels Nov 21, 2025

Shen7436 commented Nov 21, 2025

View reviewed changes

leeebo reviewed Nov 26, 2025

View reviewed changes

docs/en/additionalfeatures/dfu.rst Show resolved Hide resolved

leeebo approved these changes Nov 26, 2025

View reviewed changes

Shen7436 force-pushed the docs/translate_wokwisimulator_and_dfu branch from f11034a to ff634ca Compare November 27, 2025 03:05

docs: Provide CN translation for wokwisimulator.rst and dfu.rst

89e904a

Shen7436 force-pushed the docs/translate_wokwisimulator_and_dfu branch from ff634ca to 89e904a Compare November 27, 2025 03:09

April-Yjj approved these changes Nov 27, 2025

View reviewed changes

	2. Install USB drivers (Windows only). The drivers can be installed by the `Zadig tool <https://zadig.akeo.ie/>`_.
	2. Install USB drivers (Windows only). The drivers can be installed by `Zadig tool <https://zadig.akeo.ie/>`_.

	- Ensure that the device is in download mode before running the tool and that it detects the device before installing the drivers.
	- Ensure that the device is in download mode before running the tool, and that the tool detects the device before installing the drivers.

	- The Zadig tool might detect several USB interfaces of the target. Install the WinUSB driver only for the interface without a driver installed (likely Interface 2), and avoid re-installing drivers for other interfaces.
	- Zadig tool might detect several USB interfaces of the target. Install the WinUSB driver only for the interface without a driver installed (likely Interface 2), and avoid re-installing drivers for other interfaces.


		Additional information, including common errors and known issues, is available in `this <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#usb-drivers-windows-only>`_.

		Additional information, including common errors and known issues, is available `here <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/dfu.html#usb-drivers-windows-only>`_.

	包括常见错误和已知问题在内的更多信息，可参阅 `此处 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s3/api-guides/dfu.html#usb-windows>`_。
	包括常见错误和已知问题在内的更多信息，可参阅 `此处 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32s3/api-guides/dfu.html#api-guide-dfu-flash-errors>`_。

docs: Provide CN translation for wokwisimulator.rst and dfu.rst #1355

Are you sure you want to change the base?

docs: Provide CN translation for wokwisimulator.rst and dfu.rst #1355

Conversation

Shen7436 commented Nov 21, 2025

Uh oh!

coderabbitai bot commented Nov 21, 2025

Review skipped

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Shen7436 commented Nov 21, 2025

Uh oh!

Uh oh!

leeebo left a comment

Choose a reason for hiding this comment

Uh oh!

April-Yjj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants